#ifndef cciAggregated_h
#define cciAggregated_h
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef cciSupportsImpl_h
#include "cciSupportsImpl.h"
#endif

////////////////////////////////////////////////////////////////////////////////

// Put CCI_DECL_AGGREGATED in your class's
// declaration.
#define CCI_DECL_AGGREGATED                                                 \
    CCI_DECL_ISUPPORTS                                                      \
    CCI_DECL_AGGREGATED_HELPER

#define CCI_DECL_AGGREGATED_HELPER                                          \
public:                                                                     \
                                                                            \
    /**                                                                     \
     * Returns the cciISupports pointer of the inner object (aka the        \
     * aggregatee). This pointer is really only useful to the outer object  \
     * (aka the aggregator), which can use it to hold on to the inner       \
     * object. Anything else wants the cciISupports pointer of the outer    \
     * object (gotten by QI'ing inner or outer to cciISupports). This method\
     * returns a non-addrefed pointer.                                      \
     * @return the cciISupports pointer of the inner object                 \
     */                                                                     \
    cciISupports* InnerObject(void) { return &fAggregated; }                \
                                                                            \
    /**                                                                     \
     * Returns true if this object is part of an aggregated object.         \
     */                                                                     \
    bool IsPartOfAggregated(void) { return fOuter != InnerObject(); }    \
                                                                            \
private:                                                                    \
                                                                            \
    /* You must implement this operation instead of the cciISupports */     \
    /* methods. */                                                          \
    cci_result                                                              \
    AggregatedQueryInterface(const dmIID& aIID, void** aInstancePtr);       \
                                                                            \
    class Internal : public cciISupports {                                  \
    public:                                                                 \
                                                                            \
        Internal() {}                                                       \
                                                                            \
        CCI_IMETHOD QueryInterface(const dmIID& aIID, void** aInstancePtr); \
        CCI_IMETHOD(nsrefcnt) AddRef(void);                                 \
        CCI_IMETHOD(nsrefcnt) Release(void);                                \
                                                                            \
        CCI_DECL_OWNINGTHREAD                                               \
    };                                                                      \
                                                                            \
    friend class Internal;                                                  \
                                                                            \
    cciISupports*       fOuter;                                             \
    Internal            fAggregated;                                        \
                                                                            \
public:                                                                     \


// Put this in your class's constructor:
#define CCI_INIT_AGGREGATED(outer)                                          \
  DM_BEGIN_MACRO                                                            \
    fOuter = outer ? outer : &fAggregated;                                  \
  DM_END_MACRO


// Put this in your class's implementation file:
#define CCI_IMPL_AGGREGATED(_class)                                         \
                                                                            \
CCI_IMPL_AGGREGATED_HELPER(_class)                                          \
                                                                            \
CCI_IMETHODIMP_(nsrefcnt)                                                   \
_class::Internal::AddRef(void)                                              \
{                                                                           \
    _class* agg = (_class*)((char*)(this) - offsetof(_class, fAggregated)); \
    CCI_PRECONDITION(dm_int32(agg->mRefCnt) >= 0, "illegal refcnt");        \
    CCI_ASSERT_OWNINGTHREAD(_class);                                        \
    ++agg->mRefCnt;                                                         \
    CCI_LOG_ADDREF(this, agg->mRefCnt, #_class, sizeof(*this));             \
    return agg->mRefCnt;                                                    \
}                                                                           \
                                                                            \
CCI_IMETHODIMP_(nsrefcnt)                                                   \
_class::Internal::Release(void)                                             \
{                                                                           \
    _class* agg = (_class*)((char*)(this) - offsetof(_class, fAggregated)); \
    CCI_PRECONDITION(0 != agg->mRefCnt, "dup release");                     \
    CCI_ASSERT_OWNINGTHREAD(_class);                                        \
    --agg->mRefCnt;                                                         \
    CCI_LOG_RELEASE(this, agg->mRefCnt, #_class);                           \
    if (agg->mRefCnt == 0) {                                                \
        agg->mRefCnt = 1; /* stabilize */                                   \
        delete agg;                                                         \
        return 0;                                                           \
    }                                                                       \
    return agg->mRefCnt;                                                    \
}                                                                           \

#define CCI_IMPL_AGGREGATED_HELPER(_class)                                  \
CCI_IMETHODIMP                                                              \
_class::QueryInterface(const dmIID& aIID, void** aInstancePtr)              \
{                                                                           \
    return fOuter->QueryInterface(aIID, aInstancePtr);                      \
}                                                                           \
                                                                            \
CCI_IMETHODIMP_(nsrefcnt)                                                   \
_class::AddRef(void)                                                        \
{                                                                           \
    return fOuter->AddRef();                                                \
}                                                                           \
                                                                            \
CCI_IMETHODIMP_(nsrefcnt)                                                   \
_class::Release(void)                                                       \
{                                                                           \
    return fOuter->Release();                                               \
}                                                                           \
                                                                            \
CCI_IMETHODIMP                                                              \
_class::Internal::QueryInterface(const dmIID& aIID, void** aInstancePtr)    \
{                                                                           \
    _class* agg = (_class*)((char*)(this) - offsetof(_class, fAggregated)); \
    return agg->AggregatedQueryInterface(aIID, aInstancePtr);               \
}                                                                           \


// for use with QI macros in nsISupportsUtils.h:

#define CCI_INTERFACE_MAP_BEGIN_AGGREGATED(_class)                          \
  CCI_IMPL_AGGREGATED_QUERY_HEAD(_class)

#define CCI_IMPL_AGGREGATED_QUERY_HEAD(_class)                              \
cci_result                                                                  \
_class::AggregatedQueryInterface(DM_REFIID aIID, void** aInstancePtr)       \
{                                                                           \
  CCI_ASSERTION(aInstancePtr,                                               \
               "AggregatedQueryInterface requires a non-NULL result ptr!"); \
  if ( !aInstancePtr )                                                      \
    return CCI_ERROR_NULL_POINTER;                                          \
  cciISupports* foundInterface;                                             \
  if ( aIID.Equals(CCI_GET_IID(cciISupports)) )                             \
    foundInterface = InnerObject();                                         \
  else

#define CCI_GENERIC_AGGREGATED_CONSTRUCTOR(_InstanceClass)                  \
static cci_result                                                           \
_InstanceClass##Constructor(cciISupports *aOuter, DM_REFIID aIID,           \
                            void **aResult)                                 \
{                                                                           \
    *aResult = nsnull;                                                      \
                                                                            \
    CCI_ENSURE_PROPER_AGGREGATION(aOuter, aIID);                            \
                                                                            \
    _InstanceClass* inst = new _InstanceClass(aOuter);                      \
    if (!inst) {                                                            \
        return CCI_ERROR_OUT_OF_MEMORY;                                     \
    }                                                                       \
                                                                            \
    cciISupports* inner = inst->InnerObject();                              \
    cci_result rv = inner->QueryInterface(aIID, aResult);                   \
    if (CCI_FAILED(rv)) {                                                   \
        delete inst;                                                        \
    }                                                                       \
                                                                            \
    return rv;                                                              \
}                                                                           \

#define CCI_GENERIC_AGGREGATED_CONSTRUCTOR_INIT(_InstanceClass, _InitMethod)\
static cci_result                                                           \
_InstanceClass##Constructor(cciISupports *aOuter, DM_REFIID aIID,           \
                            void **aResult)                                 \
{                                                                           \
    *aResult = nsnull;                                                      \
                                                                            \
    CCI_ENSURE_PROPER_AGGREGATION(aOuter, aIID);                            \
                                                                            \
    _InstanceClass* inst = new _InstanceClass(aOuter);                      \
    if (!inst) {                                                            \
        return CCI_ERROR_OUT_OF_MEMORY;                                     \
    }                                                                       \
                                                                            \
    cciISupports* inner = inst->InnerObject();                              \
    CCI_ADDREF(inner);                                                      \
    cci_result rv = inst->_InitMethod();                                    \
    if (CCI_SUCCEEDED(rv)) {                                                \
        rv = inner->QueryInterface(aIID, aResult);                          \
    }                                                                       \
    CCI_RELEASE(inner);                                                     \
                                                                            \
    return rv;                                                              \
}                                                                           \

#endif /* nsAgg_h___ */
